Add OctoPrint-PlotlyGraph-LYWSD03MMC plugin entry (#1)#1416
Add OctoPrint-PlotlyGraph-LYWSD03MMC plugin entry (#1)#1416yutaka551 wants to merge 3 commits intoOctoPrint:gh-pagesfrom
Conversation
* Add OctoPrint-PlotlyGraph-LYWSD03MMC plugin entry
|
@yutaka551 Can you please fill the PR template? |
|
I can tell what it is because it integrates with my PlotlyTempGraph plugin (obviously copilot is involved). The functionality I can tell will work purely based on the programming logic, but there are issues with plugin:
|
|
Thank you very much for your thorough review and comments. You are absolutely right, and I will make the |
|
To once more repeat the request made earlier: please fill in the PR template. And speak to us directly and not through some AI please. If you are worried about your English, by all means use a translation tool like Google Translate or DeepL to help you, but don't make us feel like we are talking to ChatGPT. |
|
I have made the following changes. Please review them. Revised the setup method to use pyproject.toml. Accordingly, setup.py has been removed. |
|
I misunderstood about checking the PR template. I have filled out the PR template at the top of this pull request. I am sorry for the trouble, but I kindly ask you to review it. |
| --- | ||
| layout: plugin | ||
|
|
||
| id: OctoPrint-LYWSD03MMC-Plugin-for-PlotlyTempGraph |
There was a problem hiding this comment.
I believe this id is wrong, should be lywsd03mmc_plugin_for_plotly_temp_graph to match the entry point https://github.com/yutaka551/lywsd03mmc-plugin-for-plotly-temp-graph/blob/main/pyproject.toml#L26
| layout: plugin | ||
|
|
||
| id: OctoPrint-LYWSD03MMC-Plugin-for-PlotlyTempGraph | ||
| title: OctoPrint-LYWSD03MMC-Plugin-for-PlotlyTempGraph |
There was a problem hiding this comment.
Do you want to change this to match your plugin's display name?
LYWSD03MMC Plugin for PlotlyTempGraph
|
|
||
| --- | ||
|
|
||
| # OctoPrint-PlotlyGraph-LYWSD03MMC |
There was a problem hiding this comment.
Do you want to update this to match your readme?
LYWSD03MMC Plugin for PlotlyTempGraph
| compatibility: | ||
| octoprint: | ||
| - 1.3.6 | ||
| python: ">=3,<4" |
There was a problem hiding this comment.
should match pyproject.toml.
python: ">=3.7,<4"
|
One other thing I noticed after installing in OctoPrint is a restart wasn't triggered, only a reload. I believe this is due to the removal of the asset plugin mixin. As a result you should add the RestartNeeding plugin mixin otherwise the server won't be restarted and your plugin code won't run. |
|
Besides the observations Jim already noted above, I also took a look and didn't find anything else to flag |
jacopotediosi
left a comment
There was a problem hiding this comment.
Now that we have a static analysis scanner capable of detecting some common issues in plugins, I ran it against this plugin's code and an issue actually came up.
The plugin does not implement TemplatePlugin.is_template_autoescaped(). Since this is a relevant security feature, I'd like it to be implemented before I can give my okay on this PR.
I also took the chance to do a more thorough general review, and a few additional issues surfaced:
- The
get_temperature_datafunction is dead code. - The
callbackfunction must respect the signature of theoctoprint.comm.protocol.temperatures.receivedhook, i.e. it needs to accept the*argsand**kwargsparameters.
I'll be happy to mark the review as approved once these issues are addressed.
|
ご指摘ありがとうございます!
本業が忙しく対応できていませんが
時間が空き次第対応します!
translated with Google by jneilliii:
Thank you for pointing that out! I'm currently too busy with my main job to respond right now, but I'll get to it as soon as I have some free time.
|
What is the name of your plugin?
LYWSD03MMC Plugin for PlotlyTempGraph
What does your plugin do?
This plugin integrates Xiaomi LYWSD03MMC Bluetooth temperature and humidity sensors with OctoPrint, providing real-time environmental data visualization using Plotly graphs. It allows users to monitor temperature and humidity near their 3D printer directly from the OctoPrint interface.
Where can we find the source code of your plugin?
https://github.com/yutaka551/lywsd03mmc-plugin-for-plotly-temp-graph
Was any kind of genAI (ChatGPT, Copilot etc) involved in creating this plugin?
Yes, GitHub Copilot were used to assist with code generation and documentation.
Is your plugin commercial in nature?
No, this plugin is open-source and not commercial.
Does your plugin rely on some cloud services?
No, the plugin operates locally and does not depend on any cloud services.
Further notes
None